-
Notifications
You must be signed in to change notification settings - Fork 25.2k
[DOCS] Remove soft limit for snapshot repositories #80745
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOCS] Remove soft limit for snapshot repositories #80745
Conversation
While not a hard limit, a snapshot repository shouldn't contain more than | ||
{max-snapshot-count} snapshots at a time. This ensures the repository's metadata | ||
doesn't grow to a size that may destabilize the master node. We recommend you | ||
set up your {slm-init} policy's retention rules to enforce this limit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@original-brownbear Let me know if we want to offer any guidance to users for sizing their snapshot repositories. I can also use this information to update the policy UI copy in Kibana.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say we shouldn't give a hard number here these days probably. Maybe we should just point out that the repository does scale to thousands of snapshots, but that larger repositories do require more memory/a larger master. Just to make it clear that people should have retention setup in SLM and can't outright run a snapshot every 5 minutes for the next 10 years without ever deleting anything?
As long as we at least make it clear that there are limits and master node costs here and that deletes are necessary eventually we're good I think.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I re-added some guidance based on your comment with 521dbb8. Let me know what you think.
If that looks good to you, I'll merge this and get a fix open for the Kibana UI.
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-distributed (Team:Distributed) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM just the -"disk space" :) Thanks @jrodewig !
snapshots you no longer need. | ||
|
||
A snapshot repository can safely scale to thousands of snapshots. However, to | ||
manage its metadata, a large repository requires more memory and disk space on |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"disk space" is not true, sorry that was my unfortunate wording above. It's really just memory that's the limiting factor here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the correction.
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit. # Conflicts: # docs/reference/slm/apis/slm-put.asciidoc # docs/reference/snapshot-restore/take-snapshot.asciidoc
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit. # Conflicts: # docs/reference/slm/apis/slm-put.asciidoc # docs/reference/snapshot-restore/take-snapshot.asciidoc
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI. It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html). Relates to elastic/elasticsearch#80745
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI. It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html). Relates to elastic/elasticsearch#80745
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI. It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html). Relates to elastic/elasticsearch#80745
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI. It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html). Relates to elastic/elasticsearch#80745
With elastic/elasticsearch#74350, we no longer recommend a 200 snapshot soft limit for snapshot repositories or SLM policies. This removes a related sentence from the Snapshot Policy UI. It also updates the docs link to point to the [create snapshot docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshots-take-snapshot.html), which include guidance on snapshot retention, rather than the [put SLM policy API docs](https://www.elastic.co/guide/en/elasticsearch/reference/master/slm-api-put-policy.html). Relates to elastic/elasticsearch#80745
As part of #74350, snapshot repositories no longer have a 200 snapshot soft limit. This removes docs related to the limit from 7.14+ branches.
cc @Leaf-Lin